/*
 $Id$

 Copyright (C) 2006-2007 by David Cotton

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software
 Foundation; either version 2 of the License, or (at your option) any later
 version.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
 Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package fr.free.jchecs.ai;

import java.io.Serializable;

import fr.free.jchecs.core.move.MoveGenerator;

/**
 * Interface presented by the class providing an evaluation function.
 * 
 * @author David Cotton
 */
public interface Heuristic extends Serializable
{
  /**
   * Reference the estimated value of a game state, for the functions of finding the best shot.
   * 
   * @param pEtat State of play.
   * @param pTrait Set to "true " if you want an evaluation from the perspective of whites.
   * @return Estimated value.
   */
  int evaluate(final MoveGenerator pEtat, final boolean pTrait);
}
